fix: correct Markdown header syntax #2
Conversation
WalkthroughThe changes primarily involve the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant System
User->>System: Clone repository
User->>System: Install packages
User->>System: Set up database
User->>System: Configure environment variables
User->>System: Run application (dev/production)
System-->>User: Application running
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.35.0)
README.md
38-38: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
| @@ -35,7 +35,7 @@ Simple-indexer requires PostgreSQL as a backend database and [TypeORM](https://g | |||
|
|
|||
| # How to run | |||
|
|
|||
| ### Developement | |||
| ### Development | |||
There was a problem hiding this comment.
Fix heading hierarchy in the README
The current heading structure is inconsistent. The document jumps from h1 ("How to run") directly to h3 ("Development"), skipping the h2 level. This violates Markdown heading hierarchy best practices.
Apply this diff to fix the heading structure:
-### Development
+## DevelopmentAdditionally, consider applying the same change to other h3 headings under main sections for consistency:
- Under "Project setup": Change 1-4 to h2
- Under "How to run": Change "Production" to h2
This would create a more logical and consistent document structure:
# Main Section (h1)
## Sub Section (h2)
### Sub-sub Section (h3)🧰 Tools
🪛 Markdownlint (0.35.0)
38-38: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
Summary by CodeRabbit